user-manager

---

user-manager

Type: Settings Directory

Argument	Type	Description
enabled	bool
authentication-port	num
accounting-port	num
certificate	enum (none)
radsec-certificate	enum (none)
use-profiles	bool
require-message-auth	enum (no | yes-access-request)

user-manager/monitor

Type: Command

Read-only Argument	Type	Description
active-sessions	num

user-manager/generate-report

Type: Command

Argument	Type	Description
columns	ubit (username, session-start, session-end, user-ip, calling-station-id, uptime, download, upload, acct-session-id, nas-ip-address, nas-port-type, nas-port-id, terminate-cause, nas-identifier)
report-template	enum

user-manager/advanced

Type: Settings Directory

Argument	Type	Description
web-private-username	string
web-private-password	string
paypal-allow	bool
paypal-use-sandbox	bool
paypal-user	string
paypal-password	string
paypal-signature	string
paypal-currency	string

user-manager/router

Type: Directory

Flag	Name	Description
X	disabled	disabled

Argument	Type	Description
name ( mandatory )	string
address ( mandatory )	address (flags=46/)
protocol	enum (udp | radsec)
shared-secret	string
coa-port	num

user-manager/router/monitor

Type: Command

Read-only Argument	Type	Description
broken-requests	num
unknown-requests	num
access-requests	num
access-failures	num
accounting-requests	num
accounting-failures	num
disconnect-ack	num
disconnect-nak	num
coa-ack	num
coa-nak	num
sent-from-cache	num

user-manager/router/reset-counters

Type: Command

user-manager/attribute

Type: Directory

Flag	Name	Description
*	default	default

Argument	Type	Description
name ( mandatory )	string
vendor-id	enum (standard | Cisco | Microsoft | Mikrotik)
type-id ( mandatory )	num
value-type ( mandatory )	enum (ip-address | string | uint32 | hex | ip6-prefix | macro)
packet-types	ubit (access-accept, access-challenge)

Read-only Argument	Type	Description
default-name	string
standard-name	string

user-manager/user

Type: Directory

Flag	Name	Description
X	disabled	disabled

Argument	Type	Description
name ( mandatory )	string
password	string
otp-secret	string
group	enum
shared-users	enum (unlimited)
caller-id	enum (bind)
attributes	obj_arg { super { enum , :string } { enum , :string } }

user-manager/user/monitor

Type: Command

Read-only Argument	Type	Description
total-uptime	time
total-download	num
total-upload	num
active-sessions	num
active-sub-sessions	num
actual-profile	enum
attributes-details	obj_arg { super { enum , :string , :enum (ip-address | string | uint32 | hex | ip6-prefix | macro) { ip-address:radserv::attr::ATTR_TYPE_IP_ADDR, string:radserv::attr::ATTR_TYPE_STRING, uint32:radserv::attr::ATTR_TYPE_U32, hex:radserv::attr::ATTR_TYPE_HEX, ip6-prefix:radserv::attr::ATTR_TYPE_IP6_PREFIX, macro:radserv::attr::ATTR_TYPE_MACRO } , :0xstring } { enum , :string , :enum (ip-address | string | uint32 | hex | ip6-prefix | macro) { ip-address:radserv::attr::ATTR_TYPE_IP_ADDR, string:radserv::attr::ATTR_TYPE_STRING, uint32:radserv::attr::ATTR_TYPE_U32, hex:radserv::attr::ATTR_TYPE_HEX, ip6-prefix:radserv::attr::ATTR_TYPE_IP6_PREFIX, macro:radserv::attr::ATTR_TYPE_MACRO } , :0xstring } }

user-manager/user/generate-voucher

Type: Command

Argument	Type	Description
voucher-template	enum

user-manager/user/add-batch-users

Type: Command

Argument	Type	Description
username-length	num
number-of-users	num
username-prefix	string
password-length	enum (empty | same-as-username)
username-characters	ubit (uppercase, lowercase, numbers)
password-characters	ubit (uppercase, lowercase, numbers)
profile	enum
group	enum
caller-id	enum (bind)
shared-users	enum (unlimited)
disabled	bool
comment	string

user-manager/user/group

Type: Directory

Flag	Name	Description
*	default	default

Argument	Type	Description
name ( mandatory )	string
outer-auths	ubit (pap, chap, mschap1, mschap2, eap-tls, eap-ttls, eap-peap, eap-mschap2)
inner-auths	ubit (ttls-pap, ttls-chap, ttls-mschap1, ttls-mschap2, peap-mschap2)
attributes	obj_arg { super { enum , :string } { enum , :string } }

Read-only Argument	Type	Description
default-name	string

user-manager/user-profile

Type: Directory

Argument	Type	Description
user ( mandatory )	enum
profile ( mandatory )	enum

Read-only Argument	Type	Description
state	enum (waiting | running | running-active | used)
end-time	alt { enum (not-yet-running | unlimited) { not-yet-running:radserv::UNKNOWN, unlimited:radserv::UNLIMITED } , date_arg }

user-manager/user-profile/activate-user-profile

Type: Command

user-manager/profile

Type: Directory

Argument	Type	Description
name ( mandatory )	string
validity ( mandatory )	alt { enum (unlimited) { unlimited:0 } , time }
name-for-users	string
starts-when	enum (first-auth | assigned)
price	num
override-shared-users	enum (off | unlimited)

user-manager/limitation

Type: Directory

Argument	Type	Description
name ( mandatory )	string
download-limit	num
upload-limit	num
transfer-limit	num
uptime-limit	time
reset-counters-start-time	date_arg
reset-counters-interval	alt { enum (disabled | hourly | daily | weekly | monthly) { disabled:radserv::limitation::RC_NEVER, hourly:radserv::limitation::RC_HOURLY, daily:radserv::limitation::RC_DAILY, weekly:radserv::limitation::RC_WEEKLY, monthly:radserv::limitation::RC_MONTHLY } , time }
rate-limit-rx	num
rate-limit-tx	num
rate-limit-burst-rx	num
rate-limit-burst-tx	num
rate-limit-burst-threshold-rx	num
rate-limit-burst-threshold-tx	num
rate-limit-burst-time-rx	time
rate-limit-burst-time-tx	time
rate-limit-min-rx	num
rate-limit-min-tx	num
rate-limit-priority	num

user-manager/profile-limitation

Type: Directory

Argument	Type	Description
profile ( mandatory )	enum
limitation ( mandatory )	enum
from-time	time
till-time	time
weekdays	ubit (sunday, monday, tuesday, wednesday, thursday, friday, saturday)

user-manager/session

Type: Directory

Flag	Name	Description
A	active	active

Read-only Argument	Type	Description
user	enum
acct-session-id	string
acct-multi-session-id	string
nas-port-type	enum (async | sync | isdn-sync | isdn-sync-v120 | isdn-sync-v110 | virtual | piafs | hdlc | x25 | x75 | g3-fax | sdsl | adsl-cap | adsl-dmt | idsl | ethernet | dsl | cable | wireless | wireless-802.11)
nas-port-id	string
nas-ip-address	alt { ipAddr , ip6Addr }
nas-identifier	string
calling-station-id	string
user-address	ipAddr
status	ubit (start, stop, interim, close-acked, expired)
started	date_arg
ended	date_arg
terminate-cause	enum (user-request | lost-carrier | lost-service | idle-timeout | session-timeout | admin-reset | admin-reboot | port-error | nas-error | nas-request | nas-reboot | port-unneeded | port-preempted | port-suspended | service-unavailable | callback | user-error | host-request | supplicant-restart | reauthentication-failure | port-reinitialized | port-administratively-disabled | um-user-deleted | um-user-disabled | um-admin-request | um-nas-rebooted | um-simultaneous-sessions | um-limits-reached | um-limits-changed | um-unknown)
uptime	time
download	num
upload	num
last-accounting-packet	date_arg

user-manager/session/close-session

Type: Command

user-manager/database

Type: Settings Directory

Argument	Type	Description
db-path	string

Read-only Argument	Type	Description
found-legacy-db-path	string
db-size	num
free-disk-space	num

user-manager/database/migrate-legacy-db

Type: Command

Argument	Type	Description
database-path	file_enum
overwrite	bool

user-manager/database/load

Type: Command

Argument	Type	Description
name	file_enum { }

user-manager/database/save

Type: Command

Argument	Type	Description
name	file_enum { }
overwrite	bool

user-manager/database/optimize-db

Type: Command

user-manager/payment

Type: Directory

Argument	Type	Description
user	enum
profile	enum
price	num
currency	string
trans-start	date_arg
trans-end	alt { enum (not-finished) { not-finished:0 } , date_arg }
trans-status	enum (started | pending | approved | declined | error | timeout | aborted | user-approved)
method	enum (paypal | authorize-net)
user-message	string